Docs: Add CONTRIBUTING.md#306
Conversation
Signed-off-by: Avnish Jaltare <avnishjaltare8@gmail.com>
volcano-sh-bot
added
the
kind/documentation
|
Welcome @Maximus-08! It looks like this is your first PR to volcano-sh/agentcube 🎉 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive CONTRIBUTING.md file to guide new contributors through the project's workflow, coding standards, and testing requirements. The review feedback suggests correcting a missing Slack link reference, updating the Code of Conduct URL to use the main branch, recommending the use of make fmt for consistency with other tooling, and simplifying documentation paths for better alignment with the project structure.
There was a problem hiding this comment.
Pull request overview
Adds a top-level contributor guide for AgentCube to standardize onboarding and set expectations for contribution workflow, testing, and governance references.
Changes:
- Introduces
CONTRIBUTING.mdwith a contribution workflow (branching, PRs, review loop). - Documents project tooling/testing commands and expectations.
- Adds guidance around documentation updates, governance/ownership, and security reporting.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #306 +/- ##
==========================================
+ Coverage 47.57% 49.12% +1.55%
==========================================
Files 30 30
Lines 2819 2858 +39
==========================================
+ Hits 1341 1404 +63
+ Misses 1338 1301 -37
- Partials 140 153 +13
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Avnish Jaltare <avnishjaltare8@gmail.com>
| * Document new features under `docs/` and update READMEs/examples when behavior changes | ||
|
|
||
| ## AI Guidance | ||
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI generated PRs and AI generated commit messages are discouraged. |
|
@hzxuzhonghu If this looks okay then can we merge this ? |
Signed-off-by: Avnish <avnishjaltare8@gmail.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hzxuzhonghu The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR adds a
CONTRIBUTING.mdguide for agentcube. Standard practice across all open source repos and used as the first step in onboarding new contributors . Adapted from the contributing guide of Kthena.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: